home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / maximus / maxlg132.zip / MAXLOG.DOC < prev    next >
Text File  |  1991-10-05  |  8KB  |  205 lines
  1. Maxlog Documentation v1.3
  2.  
  3. Written by: Pete Norloff, 109/347@fidonet  2/10/91
  4.  
  5. modified to include Binkleyterm log files 3/3/91
  6. bug fixes, minor functional additions, version 1.3 10/5/91
  7.  
  8. SUMMARY
  9. -------
  10. Maxlog is a fairly simple program for generating statistical
  11. bulletins for a Maximus BBS.
  12.  
  13. Maxlog generates a list of the most popular 45 files along with
  14. a few overall statistics like total number of files downloaded
  15. during a given period, total number of K bytes downloaded, and
  16. total number of different files downloaded.
  17.  
  18. In addition to the files bulletin, Maxlog also generates a summary
  19. graph showing the average percent of system time used by hour over
  20. an average day.
  21.  
  22. Maxlog can now accept Binkleyterm log files in addition to Maximus
  23. files.
  24.  
  25. New to version 1.3:
  26.   Fixed a bug handling outbound mail calls under Binkley.
  27.   Fixed a bug that caused a trap with files without paths.
  28.   Eliminated the logging of files with the ".RSP" extention.
  29.  
  30. OPERATION
  31. ---------
  32. Maxlog maintains a data file which it produces from the log files
  33. generated by Maximus and Binkleyterm.  Since I created this
  34. program for my own use, and I use Maximus's "trace" log mode, the
  35. program is likely to work only if you use the trace mode of event
  36. logging.
  37.  
  38. It is VERY IMPORTANT TO NOTE that Maxlog *DELETES* log files.  The
  39. way Maxlog maintains its data file is that every time it is run,
  40. it extracts statistics from the log files you name, appends those
  41. statistics to Maxlog.Dat, then deletes the log files.  In the
  42. notes below, I describe the "Archive" keyword in the configuration
  43. file which instructs Maxlog to archive log file data to a file
  44. called <filename>.Sav, where <filename> is the name of your log
  45. file without the extention.  If you use this feature, no data is
  46. actually lost, it just moves from your logfile to the save file
  47. every time you run Maxlog.
  48.  
  49. Maxlog should be put in with your other daily events and run once
  50. per day.  It must be run when no log files are open.  If by
  51. chance, a copy of Binkleyterm or Maximus is still running, that
  52. log file (or those log files) will be skipped.  It is not a good
  53. practice to let Maxlog run when Bink or Max is still running.
  54.  
  55. Maxlog is an OS/2 application.  I may get around to binding it one
  56. of these days, but I have no need for a DOS version of the
  57. program.
  58.  
  59. The program can be run with a single parameter: "skip" as in
  60. "Maxlog skip".  This will cause the program to re-generate the
  61. bulletins from the data file without attempting to capture any
  62. more data from the log files.  It is perfectly safe to run Maxlog
  63. in this mode while callers are online.
  64.  
  65. Maxlog can create bulletins for up to 4 Maximus nodes (or more if
  66. you want to edit the source code).  It can sumarize data over a
  67. period of 1 to 365 days.
  68.  
  69. If you are interested in two sets of bulletins - one for Max and
  70. the other for Bink, Maxlog can be run from two seperate
  71. subdirectories.  Set one configuration file for 0 Max log files
  72. and >0 Bink log files; set the other one for the opposite.
  73.  
  74.  
  75. EXAMPLE COMMAND FILE FOR RUNNING MAXLOG
  76. ---------------------------------------
  77. @Echo Off
  78. REM update activity bulletins
  79. if exist c:\max\active??.bbs goto leave
  80. C:
  81. cd \Max
  82. Maxlog
  83. copy Top_Dl.Txt Bulletin
  84. cd \Bink
  85. Echo
  86.  
  87. :leave
  88.  
  89.  
  90. MAXLOG CONFIGURATION FILE (Maxlog.Cfg)
  91. --------------------------------------
  92. ; This line describes the BBS as you want it to appear in the
  93. ; bulletins
  94. Name the OS/2 Shareware BBS
  95.  
  96. ; This is the number of log files to be processed.
  97. NFiles 2
  98.  
  99. ; This line contains the file names for each of the files to be
  100. ; processed.  All file names must eb on this one line.
  101. FileNames Max1.Log Max2.Log
  102.  
  103. ; This is the number of Binkley log files to be processed.
  104. NBinkFiles 2
  105.  
  106. ; This line contains the file names for each of the files to be
  107. ; processed.  All file names must eb on this one line.
  108. BinkFileNames d:\Bink\Bink.log d:\Node2\Bink.log
  109.  
  110. ; This defines the name of you outbound directory.  Any file in
  111. ; the Binklog which has this path or any path below it will not
  112. ; be counted as a file request or included in the Top_Dl bulletin.
  113. Outbound c:\Bink\Outbound
  114.  
  115. ; The number of days to keep and produce bulletins for.
  116. Days 90
  117.  
  118. ; The presence of this keyword forces Maxlog to append old
  119. ; logfiles to a save file with the name <filename>.Sav. (where
  120. ; <filename> would be "Max" for a logfile named "Max.Log".
  121. Archive
  122.  
  123. ; This line defines the number of text lines in the usage graph
  124. UsageLines 20
  125.  
  126.  
  127. EXAMPLE OUTPUT
  128. --------------
  129. Top_Dl.Txt:
  130. Top Files downloaded from the OS/2 Shareware BBS: 
  131. Generated: 03-03-1991 at 15:13
  132.      ALLFILES.ZIP 432     PMDMAP10.ZIP  49      CDRIVER.ZIP  37
  133.         PMZIP.ZIP 116      REVERSI.ZIP  49      PMPAINT.ZIP  36
  134.        IBMOS2.ZIP 111       GRALIG.ZIP  47     OS2YOU18.ZIP  35
  135.          NEWS.ZIP  93     COMPRESS.ZIP  45     SIMPSONS.ZIP  34
  136.      JPOS2INI.ZIP  92     PSTCRYPT.ZIP  45     OS2ICONS.ZIP  34
  137.      OS2WORLD.ZIP  82     EZYCOPY1.ZIP  44       ALPM15.ZIP  34
  138.       ASTRO20.ZIP  79       WORDOS.ZIP  44     OS2YOU17.ZIP  34
  139.       CLIP11B.ZIP  76       SNTFRA.ZIP  43      SEMINAR.ZIP  34
  140.        BATTLE.ZIP  63     OS2YOU16.ZIP  43     PMCOM107.ZIP  33
  141.          NEKO.ZIP  60     PLAYBILL.ZIP  42     OS2S13UP.ZIP  32
  142.        ARC13P.ZIP  54       SEEPM2.ZIP  42       MARYDL.ZIP  32
  143.       PMCHESS.ZIP  52       BRICK2.ZIP  39      SMK_DLL.ZIP  31
  144.        BLKCHA.ZIP  52       RXCOMM.ZIP  38      SMK_SOL.ZIP  31
  145.       BOWLIBM.ZIP  52       PMLOAD.ZIP  38     PMVIEW4A.ZIP  31
  146.        CALIGU.ZIP  50       WHYOS2.ZIP  38     SHUTDWN3.ZIP  31
  147.  
  148. For a period covering the last 90 days:
  149. Total number of files downloaded: 9022
  150. Total number of K bytes downloaded: 523751
  151. A total of 1134 different files have been downloaded
  152.  
  153.  
  154. Hours.Txt:
  155.  
  156. Percentage of system usage by hour, generated: 03-03-1991 at 15:13
  157. Summarized over the last 90 days
  158. 100%
  159.  95%
  160.  90%
  161.  85%
  162.  80%                                         █
  163.  75%                                █  █  █  █  █  █  █  █                 █
  164.  70%  █                          █  █  █  █  █  █  █  █  █  █  █  █  █     █
  165.  65%  █                          █  █  █  █  █  █  █  █  █  █  █  █  █  █  █
  166.  60%  █  █                    █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █
  167.  55%  █  █                    █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █
  168.  50%  █  █                 █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █
  169.  45%  █  █                 █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █
  170.  40%  █  █  █              █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █
  171.  35%  █  █  █  █           █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █
  172.  30%  █  █  █  █           █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █
  173.  25%  █  █  █  █           █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █
  174.  20%  █  █  █  █        █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █
  175.  15%  █  █  █  █        █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █
  176.  10%  █  █  █  █  █     █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █
  177.   5%  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █  █
  178.       0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
  179.  
  180.  
  181. Also, two additional files are generated: All_Dl.Txt and Usage.Txt
  182. These two files are raw statistics for Sysop info only.
  183.  
  184.  
  185. FUTURE PLANS
  186. ------------
  187. I have tried to make the data collected in Maxlog.Dat fairly
  188. general so that additional viewing programs could be put together
  189. in the future.  One program I'd like to write is a PM program that
  190. lets you view the system activity by day in a graphic form. 
  191. Something with 24 lines and 60 columns representing the minutes
  192. of the day, with different colors representing Binkley activity
  193. and Maximus activity.  I know this might be getting a bit carried
  194. away, but heck, I'm having a good time.
  195.  
  196. Sooner than a PM program, I plan to make the chart above
  197. distinguish between Bink and Max usage.  
  198.  
  199. Thanks to John Tarbox for ideas on presentation, and to Emmitt
  200. Dove for prodding me into including Binkley activity.
  201.  
  202. I welcome comments and suggestions.
  203.  
  204. Pete Norloff
  205.